feat(models): add typed model classes for TableBlock cells and column_settings by srtaalej · Pull Request #1939 · slackapi/python-slack-sdk

srtaalej · 2026-08-06T17:46:06Z

Summary

Adds typed model classes for TableBlock cells and column settings, so developers get autocomplete and validation instead of hand-building dicts.

TableBlockColumnSettings — typed class for column settings with align and is_wrapped
RichTextBlock (pre-existing) — already covers rich_text table cells
RawTextObject (pre-existing) — already covers raw_text cells

TableBlock type annotations are widened to accept both typed objects and raw dicts for full backward compatibility.

Note: raw_number cell support is not included in this PR because client rendering for that type is not yet confirmed across platforms.

Closes #1938

Testing

Test app.py

import os
import logging

from slack_bolt import App
from slack_bolt.adapter.socket_mode import SocketModeHandler
from slack_sdk.models.blocks import (
    RawTextObject,
    RichTextBlock,
    TableBlock,
    TableBlockColumnSettings,
)

logging.basicConfig(level=logging.DEBUG)

app = App(token=os.environ["SLACK_BOT_TOKEN"], request_verification_enabled=False)


@app.message("table")
def handle_table_message(message, client):
    channel = message["channel"]

    table = TableBlock(
        rows=[
            [
                RawTextObject(text="Item"),
                RawTextObject(text="Qty"),
                RawTextObject(text="Notes"),
            ],
            [
                RawTextObject(text="Apples"),
                RawTextObject(text="5"),
                RichTextBlock(
                    elements=[{"type": "rich_text_section", "elements": [{"type": "text", "text": "Fresh from the market"}]}]
                ),
            ],
            [
                RawTextObject(text="Bananas"),
                RawTextObject(text="12"),
                RichTextBlock(elements=[{"type": "rich_text_section", "elements": [{"type": "text", "text": "Organic"}]}]),
            ],
        ],
        column_settings=[
            TableBlockColumnSettings(align="left"),
            TableBlockColumnSettings(align="right"),
            TableBlockColumnSettings(align="left", is_wrapped=True),
        ],
    )

    client.chat_postMessage(
        channel=channel,
        text="Here's a table with typed model classes:",
        blocks=[table.to_dict()],
    )


if __name__ == "__main__":
    SocketModeHandler(app, os.environ.get("SLACK_APP_TOKEN")).start()

Requirements

I've read and understood the Contributing Guidelines and have done my best effort to follow them.
I've read and agree to the Code of Conduct.

…_settings (#1938)

codecov · 2026-08-06T17:58:51Z

Codecov Report

❌ Patch coverage is 61.11111% with 7 lines in your changes missing coverage. Please review.
✅ Project coverage is 84.11%. Comparing base (ae87985) to head (e80261f).
✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
slack_sdk/models/blocks/basic_components.py	58.82%	7 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1939      +/-   ##
==========================================
- Coverage   84.17%   84.11%   -0.07%     
==========================================
  Files         118      118              
  Lines       13425    13442      +17     
==========================================
+ Hits        11301    11307       +6     
- Misses       2124     2135      +11

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

zimeg

@srtaalej Before marking this for merge I have a suggestions that reuses the rich_text block to save some duplication and keep the cell most current 🐣 I'll share the schema I find this at in channel!

zimeg · 2026-08-07T19:14:18Z

+class RichTextCell(JsonObject):
+    """A rich_text typed cell for use in TableBlock rows."""
+
+    type = "rich_text"
+
+    @property
+    def attributes(self) -> Set[str]:
+        return {"type", "elements"}
+
+    def __init__(
+        self,
+        *,
+        elements: Sequence[Union[Dict[str, Any], Any]],
+        **others: dict,
+    ):
+        """A rich text cell used in table block rows.
+        https://docs.slack.dev/reference/block-kit/blocks/table-block
+
+        Args:
+            elements (required): An array of rich text element objects
+                (rich_text_section, rich_text_list, rich_text_quote, rich_text_preformatted).
+        """
+        show_unknown_key_warning(self, others)
+        self.type = self.__class__.type
+        from slack_sdk.models.blocks.block_elements import BlockElement
+
+        self.elements = BlockElement.parse_all(elements)
+
+    @classmethod
+    def parse(cls, cell: Optional[Union[Dict[str, Any], "RichTextCell"]]) -> Optional["RichTextCell"]:
+        if cell is None:
+            return None
+        if isinstance(cell, RichTextCell):
+            return cell
+        if isinstance(cell, dict):
+            d = {k: v for k, v in cell.items() if k != "type"}
+            return RichTextCell(**d)
+        return None
+
+


Suggested change

class RichTextCell(JsonObject):

"""A rich_text typed cell for use in TableBlock rows."""

type = "rich_text"

@property

def attributes(self) -> Set[str]:

return {"type", "elements"}

def __init__(

self,

*,

elements: Sequence[Union[Dict[str, Any], Any]],

**others: dict,

):

"""A rich text cell used in table block rows.

https://docs.slack.dev/reference/block-kit/blocks/table-block

Args:

elements (required): An array of rich text element objects

(rich_text_section, rich_text_list, rich_text_quote, rich_text_preformatted).

"""

show_unknown_key_warning(self, others)

self.type = self.__class__.type

from slack_sdk.models.blocks.block_elements import BlockElement

self.elements = BlockElement.parse_all(elements)

@classmethod

def parse(cls, cell: Optional[Union[Dict[str, Any], "RichTextCell"]]) -> Optional["RichTextCell"]:

if cell is None:

return None

if isinstance(cell, RichTextCell):

return cell

if isinstance(cell, dict):

d = {k: v for k, v in cell.items() if k != "type"}

return RichTextCell(**d)

return None

🪓 note: I think here we can use the existing RichTextBlock similar to @slack/types implementation:

https://github.com/slackapi/node-slack-sdk/blob/122865134ffa20ad080fcf447cfb93b7252da157/packages/types/src/block-kit/blocks.ts#L450-L467

zimeg · 2026-08-07T19:15:38Z

        return len(self.text) >= 1


+class ColumnSettings(JsonObject):


Suggested change

class ColumnSettings(JsonObject):

class TableBlockColumnSettings(JsonObject):

📣 note: Hoping to namespace this to match the @slack/types package too but also to avoid confusion on which columns this settings are applied:

https://github.com/slackapi/node-slack-sdk/blob/122865134ffa20ad080fcf447cfb93b7252da157/packages/types/src/block-kit/blocks.ts#L469-L482

👾 note: Please know I'm less confident about this change so consider it a non-blocking preference!

…BlockColumnSettings

zimeg

@srtaalej A few more comments but not so blocking. I'm curious if I'm overthinking the placement of TableBlockColumnSettings but I do think strengthening some tests will give us more confidence in parsings and examples.

zimeg · 2026-08-10T22:19:04Z

+
+    def test_with_rich_text_cell_objects(self):
+        """Test table using typed RichTextBlock objects"""
+        cell = RichTextBlock(elements=[{"type": "rich_text_section", "elements": [{"type": "text", "text": "Hello"}]}])


🪬 suggestion: Let's strengthen the parsing checks of this test with rich text elements too!

Suggested change

cell = RichTextBlock(elements=[{"type": "rich_text_section", "elements": [{"type": "text", "text": "Hello"}]}])

cell = RichTextBlock(

elements=[RichTextSectionElement(elements=[RichTextElementParts.Text(text="Hello")])]

)

zimeg · 2026-08-10T22:23:40Z

        return len(self.text) >= 1


+class TableBlockColumnSettings(JsonObject):


🧮 question: I'm curious if keeping this beside the TableBlock implementation is best? Or if it's right to keep here? AFAICT we won't share these settings with other blocks...

feat(models): add typed model classes for TableBlock cells and column…

ab98fbe

…_settings (#1938)

fix(models): remove RawNumberCell until client rendering is confirmed

5325ecb

srtaalej self-assigned this Aug 6, 2026

srtaalej added enhancement M-T: A feature request for new functionality semver:minor labels Aug 6, 2026

docs(models): align ColumnSettings docstrings with official docs

8df84fa

srtaalej marked this pull request as ready for review August 6, 2026 19:11

srtaalej requested a review from a team as a code owner August 6, 2026 19:11

Merge branch 'main' into table-block-typed-models

90a4b8c

zimeg reviewed Aug 7, 2026

View reviewed changes

srtaalej added 2 commits August 10, 2026 12:59

refactor(models): remove RichTextCell, rename ColumnSettings to Table…

61b147a

…BlockColumnSettings

style(models): fix line length in TableBlockColumnSettings.parse

e80261f

srtaalej requested a review from zimeg August 10, 2026 20:39

zimeg approved these changes Aug 10, 2026

View reviewed changes

zimeg added the Version: 3x label Aug 10, 2026

Navigation Menu

Uh oh!

feat(models): add typed model classes for TableBlock cells and column_settings - #1939

feat(models): add typed model classes for TableBlock cells and column_settings#1939
srtaalej wants to merge 6 commits into
mainfrom
table-block-typed-models

srtaalej commented Aug 6, 2026 •

edited

Loading

Uh oh!

codecov Bot commented Aug 6, 2026 •

edited

Loading

Uh oh!

zimeg left a comment

Uh oh!

zimeg Aug 7, 2026

Uh oh!

zimeg Aug 7, 2026

Uh oh!

zimeg left a comment

Uh oh!

zimeg Aug 10, 2026

Uh oh!

zimeg Aug 10, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	class ColumnSettings(JsonObject):
	class TableBlockColumnSettings(JsonObject):

		return len(self.text) >= 1


		class TableBlockColumnSettings(JsonObject):

Uh oh!

Conversation

srtaalej commented Aug 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Testing

Requirements

Uh oh!

codecov Bot commented Aug 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

zimeg left a comment

Choose a reason for hiding this comment

Uh oh!

zimeg Aug 7, 2026

Choose a reason for hiding this comment

Uh oh!

zimeg Aug 7, 2026

Choose a reason for hiding this comment

Uh oh!

zimeg left a comment

Choose a reason for hiding this comment

Uh oh!

zimeg Aug 10, 2026

Choose a reason for hiding this comment

Uh oh!

zimeg Aug 10, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

srtaalej commented Aug 6, 2026 •

edited

Loading

codecov Bot commented Aug 6, 2026 •

edited

Loading